home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 7: Sunsite / Linux Cubed Series 7 - Sunsite Vol 1.iso / system / misc / x10-amh-.000 / x10-amh- / x10-amh-v1.04 / README.x10-amh < prev    next >
Text File  |  1996-02-13  |  5KB  |  130 lines
  1. X10-AMH - README -- Version 1.04 (With support for writing to CP-290 local ram)
  2.  
  3. // Author      : Copyright (C) 1995 Aaron Hightower (aaron@paradigmsim.com)
  4. //               1217 Shirley Way
  5. //               Bedford, TX  76022 (817)267-6001
  6. //
  7. // Bugfixes    : Bruce Perens (bruce@beagle.pixar.com)
  8. //             : Aaron Hightower
  9. //
  10. //  This program is free software; you can redistribute it and/or modify
  11. //  it under the terms of the GNU General Public License as published by
  12. //  the Free Software Foundation; either version 2 of the License, or
  13. //  (at your option) any later version.
  14. //
  15. //  This program is distributed in the hope that it will be useful,
  16. //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18. //  GNU General Public License for more details.
  19. //
  20. //  You should have received a copy of the GNU General Public License
  21. //  along with this program; if not, write to the Free Software
  22. //  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  23.  
  24. X10 HARDWARE: (What's an X10?)
  25.  
  26. An X10 Module is a device that you plug into your AC wall socket.  It
  27. allows you to do two things: (1) Turn appliances in your home on and off
  28. and (2) dim and brighten lights.  There are three classes of X10 devices:
  29. (1) X10 controlling device (2) X10 on/off switch (3) X10 on/off/dimmer.
  30. Within these classes there are many many many types of specific devices.
  31. Some with built in alarm clocks, and sensors for allowing you to install
  32. an alarm in your home.  Loud sirens that you can use to scare off
  33. burglars, etc.
  34.  
  35. You can buy all of the X10 devices from Radio Shack in the States or you
  36. can mail order them from several different mail order catalogs.
  37.  
  38. There is one device that you absolutely need.  That's the X10 computer
  39. control device.  Also know as the X10 home automation control interface.
  40.  
  41. The model number of the controller device is CP-290.  The CP-290 has two
  42. wires hanging out of it.  One is a serial connector that connects to
  43. your computer.  The other is a standard wall plug.
  44.  
  45. This (X10-AMH) software messages across one of your computer's serial
  46. ports to the CP-290.  From there the CP-290 sends messages across your
  47. AC wiring to turn on/off appliances plugged in to X10 appliance modules
  48. or to dim/brighten lights attached to one of the X10 dimmer modules.
  49.  
  50. Appliances are plugged into the appliance module, and the appliance module
  51. plugs into the wall outlet.
  52.  
  53. The CP-290P is available from both Radio Shack and from Altex
  54. Electronics in Dallas (US phone 1-800-531-5369).  Currently they are US
  55. $45 at Altex and come with Windoze Software (model CP-290P).  Make sure
  56. you don't get the Mac software (CP-290M) by mistake.
  57.  
  58. Radio Shack has usually has them, but they were more than US $60 last
  59. time I checked.
  60.  
  61. Bottom line?  Get it at Altex mail order and make sure you get the CP-290P.
  62.  
  63.                 Get the CP-290P
  64.                       ^
  65.  
  66. DISCLAIMER:
  67.  
  68. I do not have any affiliation to Altex other than they are a few blocks
  69. from where I live.  You may find them cheaper/better or whatever, this
  70. is just to limit the amount of mail I get asking where the CP-290 can
  71. be found.
  72.  
  73. USING THE X10-AMH SOFTWARE:
  74.  
  75. The first thing you need to do is find a free serial port to hook up your
  76. CP-290.  Follow the instructions with your CP-290 to do that.
  77.  
  78. After you know the device name of the CPU-290 (EG: /dev/ttyS3) you can
  79. do one of two things.
  80.  
  81. Assume your CP-290 is hooked up to /dev/ttyS3:
  82.  
  83.   (1) setenv X10_PORTNAME /dev/ttyS3
  84.   (2) su ; ln -s /dev/ttyS3 /dev/x10
  85.  
  86. If you choose option (1), you'll need to modify your ~/.login to do this
  87. each time you login.  I, personally, prefer option 2.
  88.  
  89. To get help, run the application with no options, and a help screen will
  90. be printed listing sample uses of the application.
  91.  
  92. You can use X10-AMH from the shell or from a crontab to wake yourself up
  93. in the morning with lights or your stereo, or you could turn your
  94. monitor off at the times you usually forget to do so, or your TV.
  95.  
  96. BUGS:
  97.  
  98. This app doesn't do any kind of serial port locking, so if you run it
  99. twice at one, it might barf.
  100.  
  101. Please report bugs and bug fixes to aaron@paradigmsim.com.
  102.  
  103. New features:
  104.  
  105. This application will give you full control over your X10 modules.  In
  106. fact it will now even let you set up events in the CP-290's local RAM so
  107. that you can leave your computer turned off and still have the CP-290
  108. control your home appliances.  This can save you a lot of electricity
  109. if your computer sucks the juice.
  110.  
  111. There's an example .x10 file called "sample.x10" that you can send.
  112.  
  113. % x10-amh sample.x10
  114.  
  115. NOTE: You need to set the clock before sending a file to the CP-290's memory.
  116. See /sbin/clock for writing the CMOS clock.  clock --help for info.  Once
  117. you're clock is set, use "x10-amh -s" to set the CP-290's clock based on
  118. the system's date.
  119.  
  120. If you want to get the contents of memory and save it to a file, use this
  121.  
  122. % x10-amh -l > file.x10
  123.  
  124. This will help to give you hint about the format of the .x10 file.  Until
  125. the documentation for this format is complete, you'll need to read the
  126. source code if you are interested in the subtleties.
  127.  
  128. ==============================================================================
  129.  
  130.